Skip to main content

Followup Child

Service: Followup (Child)

  1. Base URL:
    http://zm.irdresearch.org/mrest/followup

  1. Description
    The Follow-Up Service is designed to facilitate the tracking and follow-up of enrolled children in the ZM system through the mobile application. This service updates or adds new data regarding the child's health, vaccination status, and other key metrics after the initial enrollment. It is a critical part of ensuring ongoing monitoring and data collection for each child’s health journey, supporting healthcare providers with up-to-date information.
    The service allows updates to data related to the following key areas:
  • Child

  • Child Analysis

  • Vaccination

  • Address

  • Contact Number

  • Identifier

  • MCCT Visit (Non-Mandatory)

    Through follow-up, the service ensures that information regarding a child's health, vaccination schedule, and other data points is kept updated. This ongoing data collection supports continuous healthcare interventions and monitoring.


  1. Request Format

    All requests must be sent using HTTP POST method.


  1. Response Format
  • Content-Type: application/json
  • Success Response: A 200 OK HTTP status code with the appropriate JSON response body.
  • Failure Response: A 200 OK HTTP status code with no JSON content, only a code value of 2 to indicate failure due to an incomplete operation or unknown reasons.
  • Server Error Response: A 500 Internal Server Error HTTP status code when a server-side error occurs.

  1. Dependencies

    The child follow-up API stores data into multiple tables in the system, including:

  • Child
  • Child Analysis
  • Vaccination
  • Address
  • Contact Number
  • Identifier
  • MCCT Visit

  1. Schema

    Below are the key entities utilized by the Follow-Up Service:

  2. Child

  3. Child Analysis

  4. Vaccination

  5. Address

  6. Contact Number

  7. Identifier

  8. MCCT Visit

    This API documentation outlines the Follow-Up Service for children, detailing the request format, schema for key data entities, and expected response formats for success, failure, and error cases. The follow-up service plays a critical role in maintaining updated child health data within the system.


  1. Flow Chart

Locale Dropdown